Skip to content

docs: add agentic workflow context files#1375

Merged
tekton-robot merged 1 commit into
tektoncd:mainfrom
ab-ghosh:agent-ready-context-files
Jun 8, 2026
Merged

docs: add agentic workflow context files#1375
tekton-robot merged 1 commit into
tektoncd:mainfrom
ab-ghosh:agent-ready-context-files

Conversation

@ab-ghosh

@ab-ghosh ab-ghosh commented May 28, 2026

Copy link
Copy Markdown
Member

Changes

Prepare the Tekton Catalog repository for agentic workflows.

  • AGENTS.md: agent-oriented context file covering build/test commands, catalog conventions (TEP-0003, mandatory metadata, script interpolation security, versioning workflow), architecture, pattern references, and PR guidelines
  • CLAUDE.md: symlink to AGENTS.md
  • .claude/skills/: commit-message, code-review, running-tests, and task-authoring skills adapted for this project
  • .claude/rules/: path-scoped rules for task YAMLs and test infrastructure
  • .agents/skills: symlink to .claude/skills for agent auto-discovery
  • .gitlint: commit message linting config (matches operator pattern)
  • .pre-commit-config.yaml: gitlint + conventional-pre-commit hooks
  • Makefile: lint, test, and setup targets
  • .gitignore: add missing patterns
  • README.md: add Quick Start section

agentready score

  • 69.3/100 (Silver) — baseline assessment
  • Remaining failures are out of scope for a YAML catalog repo (Python type annotations, pytest coverage, src/ layout)

Notes

  • Skills validated against 30 recent merged PRs — covers the top activities: new task creation (37%), bug fixes (17%), maintenance (43%)
  • Skills are adapted from the operator PR (tektoncd/operator#3387) and pruner PR (tektoncd/pruner#300), with
    catalog-specific scopes and examples

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Follows the authoring recommendations
  • Includes docs (if user facing)
  • Includes tests (for new tasks or changed functionality)
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Commit messages follow commit message best practices
  • Has a kind label. You can add one by adding a comment on this PR that
    contains /kind <type>. Valid types are bug, cleanup, design, documentation,
    feature, flake, misc, question, tep
  • Complies with Catalog Organization TEP, see example. Note An issue has been filed to automate this validation
    • File path follows <kind>/<name>/<version>/name.yaml

    • Has README.md at <kind>/<name>/<version>/README.md

    • Has mandatory metadata.labels - app.kubernetes.io/version the same as the <version> of the resource

    • Has mandatory metadata.annotations tekton.dev/pipelines.minVersion

    • mandatory spec.description follows the convention

        ```
      
        spec:
          description: >-
            one line summary of the resource
      
            Paragraph(s) to describe the resource.
        ```
      

See the contribution guide for more details.

@tekton-robot tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 28, 2026
@ab-ghosh ab-ghosh force-pushed the agent-ready-context-files branch 7 times, most recently from 409fb9a to fe893c1 Compare May 30, 2026 20:33
  Add AGENTS.md, skills, and supporting configuration to prepare
  the catalog repository for AI-assisted development workflows.

  - AGENTS.md (50 lines) with build/test commands, critical rules,
    and skill pointers
  - CLAUDE.md symlink to AGENTS.md
  - Skills: commit-message, code-review, running-tests,
    task-authoring, debugging-e2e-failures
  - .agents/skills symlink for cross-client interoperability
  - .claude/rules/ with path-scoped rules for tasks and tests
  - .pre-commit-config.yaml with gitlint and conventional commits
  - .gitlint for conventional commit validation
  - Makefile with lint, test, and setup targets
  - CI check enforcing 60-line limit on AGENTS.md
  - Quick Start section in README.md
  - Fix trailing whitespace in openshift-client task (pre-existing CI failure)

  AgentReady score: 69.3/100

  Signed-off-by: Abhishek Ghosh <abghosh@redhat.com>
  Assisted-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ab-ghosh ab-ghosh force-pushed the agent-ready-context-files branch from fe893c1 to bb05b40 Compare May 30, 2026 20:37
@ab-ghosh

Copy link
Copy Markdown
Member Author

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label May 30, 2026
@ab-ghosh

ab-ghosh commented Jun 8, 2026

Copy link
Copy Markdown
Member Author

/cc @vdemeester

@vdemeester vdemeester left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jun 8, 2026
@tekton-robot

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 8, 2026
@tekton-robot tekton-robot merged commit cd503bf into tektoncd:main Jun 8, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants